Updated RegexFilter implementtation with changes from 2.x branch merge to main [3.x] (#3086) #3513
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… createFilter. (apache#3086) 8d05a7
+ made AbstractFiltter.AbstractFilterBuilder onMatch/onMismatch fields protected + added AbstractFilter(AbstractFilterBuilder) constructor + added RegexFilter.Builder implementation + added RegexFilter(Builder) constructor + moved RegexFilter Pattern compile into constructor + added fields to persist configuration propertties + getters (regexExpression, patternFlags) + changed private constructor to accept builder as argument + renamed private method 'targetMessageTest' to more approprriate 'getMessageTextByType' + added Javadoc + grouped deprecations
+ added validation checks to RegexFilter + added JVerify nullability annotations to RegexFilter + updated javadoc + replaced deprecated usages of CompositeFilter#getFilters with CompositeFilter#getFiltersArray in AbstractFilterableTest
…ot yet been merged to main (apache#3086)
JWT007
added
bug
Generated by gradle/develocity-actions |
ppkarwasz
requested changes
May 16, 2025
| @PluginBuilderAttribute(ATTR_ON_MATCH) | ||
| private Result onMatch = Result.NEUTRAL; | ||
| protected Result onMatch = Result.NEUTRAL; |
There was a problem hiding this comment.
There is already a getter and a setter. Making this protected is not needed.
| @PluginBuilderAttribute(ATTR_ON_MISMATCH) | ||
| private Result onMismatch = Result.DENY; | ||
| protected Result onMismatch = Result.DENY; |
There was a problem hiding this comment.
There is already a getter and a setter. Making this protected is not needed.
Comment on lines
+86
to
92
| /** | ||
| * Returns the compiled regular-expression pattern. | ||
| * @return the pattern (will never be {@code null} | ||
| */ | ||
| public Pattern getPattern() { | ||
| return this.pattern; | ||
| } |
There was a problem hiding this comment.
Since there is already a getRegex method below, I think this method can be removed.
Comment on lines
257
to
-142
| @PluginFactory | ||
| public static RegexFilter createFilter( | ||
| // @formatter:off | ||
| @PluginAttribute final String regex, | ||
| @PluginElement final String[] patternFlags, | ||
| @PluginAttribute final Boolean useRawMsg, | ||
| @PluginAttribute final Result onMatch, | ||
| @PluginAttribute final Result onMismatch) | ||
| // @formatter:on | ||
| throws IllegalArgumentException, IllegalAccessException { | ||
| if (regex == null) { | ||
| LOGGER.error("A regular expression must be provided for RegexFilter"); | ||
| return null; | ||
| } | ||
| return new RegexFilter(useRawMsg, Pattern.compile(regex, toPatternFlags(patternFlags)), onMatch, onMismatch); |
There was a problem hiding this comment.
For backward compatibility, we can not remove this method, but we can:
- Remove the
@PluginFactoryannotation. - Deprecated it.
- Rewrite it in terms of builder calls.
Comment on lines
+258
to
260
| public static Builder newBuilder() { | ||
| return new Builder(); | ||
| } |
There was a problem hiding this comment.
A plugin builder factory must be annotated with @PluginBuilderFactory instead of @PluginFactory.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #3086
RegexFilter(Builder)private constructorMessage#getFormat()#2773 from 2.x branch that were only partially merged to mainAbstractFilter(Builder)constructorNOTE: cherry-picking changes directly from 2.x branch not possible due to missing APIs, changed 3.x Plugin design/imports, etc.